<?php
/**
 * Copyright since 2007 PrestaShop SA and Contributors
 * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/OSL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@prestashop.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
 * versions in the future. If you wish to customize PrestaShop for your
 * needs please refer to https://devdocs.prestashop.com/ for more information.
 *
 * @author    PrestaShop SA and Contributors <contact@prestashop.com>
 * @copyright Since 2007 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 */

declare(strict_types=1);

namespace Tests\Unit\Core\Configuration;

use InvalidArgumentException;
use PHPUnit\Framework\MockObject\MockObject;
use PrestaShop\PrestaShop\Core\Domain\Configuration\ShopConfigurationInterface;
use PrestaShop\PrestaShop\Core\Domain\Shop\ValueObject\ShopConstraint;

/**
 * Trait to easily mock configuration with specified configuration values passed via an array.
 * This trait must be used on a class that extends TestCase so that it can use the mock functions.
 */
trait MockConfigurationTrait
{
    protected function mockConfiguration(array $configurationValues = [], ?ShopConstraint $expectedShopConstraint = null, ?string $configurationClass = null): ShopConfigurationInterface|MockObject
    {
        $configuration = $this->createMock($configurationClass ?? ShopConfigurationInterface::class);

        if (!empty($configurationValues)) {
            $configuration
                ->method('get')
                ->will($this->returnCallback(function ($configurationName, $default, $shopConstraint) use ($configurationValues, $expectedShopConstraint) {
                    if (null !== $expectedShopConstraint) {
                        self::assertEquals($shopConstraint, $expectedShopConstraint);
                    }

                    if (isset($configurationValues[$configurationName])) {
                        return $configurationValues[$configurationName];
                    }

                    throw new InvalidArgumentException('Unhandled configuration ' . $configurationName);
                }))
            ;
        }

        return $configuration;
    }
}
